/*
 * \brief  Input session interface
 * \author Norman Feske
 * \date   2006-08-16
 */

/*
 * Copyright (C) 2006-2009 Norman Feske
 * Genode Labs, Feske & Helmuth Systementwicklung GbR
 *
 * This file is part of the Genode OS framework, which is distributed
 * under the terms of the GNU General Public License version 2.
 */

#ifndef _INCLUDE__INPUT_SESSION__INPUT_SESSION_H_
#define _INCLUDE__INPUT_SESSION__INPUT_SESSION_H_

#include <dataspace/capability.h>

namespace Input {

	class Session
	{
		protected:

			enum Opcode { DATASPACE, IS_PENDING, FLUSH };

		public:

			static const char *service_name() { return "Input"; }

			virtual ~Session() { }

			/**
			 * Return capability to event buffer dataspace
			 */
			virtual Genode::Dataspace_capability dataspace() = 0;

			/**
			 * Request input state
			 *
			 * \return  true if new events are available
			 */
			virtual bool is_pending() = 0;

			/**
			 * Flush pending events to event buffer
			 *
			 * \return  number of flushed events
			 */
			virtual int flush() = 0;
	};
}

#endif /* _INCLUDE__INPUT_SESSION__INPUT_SESSION_H_ */
